Clarify mjs_addDefault usage and document correct default class naming #2890
+12
−1
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
How is the working code? Anything else to be done? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR updates the documentation and header comments for the mjs_addDefault function to clarify its correct usage. It now explicitly states that only one unnamed default is allowed at the top level, and all other defaults should be named by passing a non-null classname. Example usage is also provided.
This is in regard to issue #2707
Changes:
Added a descriptive comment and example usage for mjs_addDefault in:
references.h
mujoco.h
user_api.h
Clarifies that only one unnamed default is allowed at the top level.
Shows how to use named and unnamed defaults correctly.
Motivation:
This change helps prevent user errors and invalid XML generation by making the API contract explicit in the documentation and headers. It addresses confusion around unnamed defaults and ensures users follow MuJoCo’s requirements for default classes.
Checklist:
Documentation updated
Example usage provided
No breaking changes to API